/*
Copyright (c) 2007, EffectiveUI, Inc.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
    * Neither the name of the EffectiveUI nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@ignore
*/
package com.effectiveui.frameworks.commando {
	
	/**
	 * An Option is a simple object containing
	 * the values defining a command line option.
	 * 
	 */	
	public class Option {
		
		/**
		* Short option name
		*/		
		public var opt:String;

		/**
		* Long option name
		*/		
		public var longOpt:String;
		
		/**
		* Option expects an argument?
		*/		
		public var expectsArgument:Boolean;
		
		/**
		* Parsed argument value
		*/		
		public var value:String;
		
		/**
		* Description of Option
		*/		
		public var description:String;
		
		/**
		* required option?
		*/		
		public var required:Boolean;
		
		/**
		 * Create option definition. Later Option
		 * will be cloned and shipped with parsed arguments (value)
		 * along with a CommandoEvent
		 * 
		 * @param opt short option name
		 * @param longOpt long option name
		 * @param hasArgument expects argument?
		 * @param description description of option
		 * @param required required?
		 * 
		 */		
		public function Option(opt:String, longOpt:String=null, hasArgument:Boolean=false, description:String=null, required:Boolean=false) {
			this.opt = opt;
			this.description = description;
			this.longOpt = longOpt;
			this.expectsArgument = hasArgument;
			this.required = required;
		}
		
		/**
		 * Does this option have a long option name?
		 * 
		 * @return Boolean has long option name?
		 * 
		 */		
		public function hasLongOpt():Boolean {
			return (longOpt != null || longOpt != '');
		}
		
		/**
		 * Makes a Commando-safe clone of this option.
		 * 
		 * @return Option clone of option
		 * 
		 */		
		public function clone():Option {
			var clone:Option = new Option(opt, longOpt, expectsArgument, description, required);
			clone.value = this.value;
			return clone;
		}
		
	}
}